home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 5 / Apprentice-Release5.iso / Environments / Prograph Classic 2.6.1 / Examples / Super_System_Classes / Hierarchical Menus ƒ / Hier Menu.ReadMe < prev   
Text File  |  1994-10-21  |  3KB  |  72 lines

  1. Example:      Hierarchical Menus
  2. Written by:  Prograph International (John Garden)
  3. Contents:     Hier Menu.pgs
  4.                    Hier Menu.ReadMe
  5.  
  6. Needs Prograph Extensions:
  7.                     Math Primitives
  8.                     More Primitives
  9.                     Primitives
  10.                     
  11.  
  12. Needs Libraries to Compile:
  13.                     SCLibrary 2.6
  14.                     Library 2.6
  15.  
  16. Standard Methods That Were Modified:
  17.                     Initial
  18.                     Menu/Quit
  19.                     Application/Update Menus
  20.                     Application/Notify**
  21.  
  22.                 **Only necessary if your Hier Menu has command-key equivalents
  23.  
  24. Description
  25. -----------
  26. Although Prograph's menu editor does not directly support the creation of hierarchical menus, this set of classes and methods makes it easy to add them to your application by following a simple naming convention for the submenu.
  27.  
  28. How To Use In Your Program
  29. --------------------------
  30. The Hier Menu class has been designed for ease of use. There are,
  31. however, a few simple rules to follow when using it.
  32.  
  33. Creating and Editing Hierarchical Menus
  34.  
  35. You can create and edit a hierarchical menu just like any other menu.
  36. Simply be sure that you actually create an instance of Hier Menu
  37. ( conversely, do not use the Hier Menu class for non-hierarchical menus).
  38.  
  39. In order to specify where a hierarchical menu is to appear in your
  40. application, follow this simple convention. The name of your hierarchical
  41. menu should consist of the name of the menu it is to appear in, and the
  42. name of the item it will be attached to, separated by a special separator
  43. character ( '^' by default. you can change this in the Hier Menu class if
  44. necessary ).
  45.  
  46. You should not add your hierarchical menus to the active list. They should
  47. reside only in the Menu Library of your application.
  48.  
  49. Installing your Hierarchical Menus
  50.  
  51. The Init routine does all the installation of your hierarchical menus. It
  52. searches the Menu Lib for all instances of Hier Menu, parses the names to
  53. determine where to install them and does the actual installation. During
  54. the installation process, your hierarchical menus will be added to the
  55. active menu list, and their names will be set to the empty string. You will
  56. notice this if you enter the menu editor while your application is running.
  57. Do not remove hierarchical menus from the active menu list. The Cleanup
  58. routine will do this for you. Because the Prograph interpreter allows you
  59. to switch context during execution, the Update routine is necessary to
  60. ensure that your hierarchical menus are always available. It does not
  61. need to be called in your compiled code. The example shows how to use
  62. the compiled? primitive to call Update when necessary.
  63.  
  64. The Key Method
  65.  
  66. The Human Interface Guidelines recommend that you not put command-key
  67. equivalents on hierarchical menu items. If you wish to do so, however,
  68. you must call the Key method in place of the sc-key-menu primitive. Note,
  69. however, that doing so will disable Prograph's special command key
  70. feature (ie option/shift/control keys in your command keys ) for your
  71. application.
  72.